Search Help Contents:

Topics

API Calls

POST /oauth2/token

GET /health

Shipments

Containers

OM Containers

Consignments and Cross-Dock

GET consignments

GET consignments/{id}

GET consignments/{id}/events

GET consignments/{id}/references

GET consignments/exactmatch

GET consignments/{id}/documents

GET consignments/{id}/documents/{documentId}/download

Get the document contents for a specific Proof of Delivery document.

Note: the documentId returned in the response containing the callback url is related to the bearer token used when the callback url was requested. If the bearer token has expired, you will need to request the callback URL via the /documents call again.

Example Request

GGET /consignments/5555/documents/AWzuzHXANd9erOsPSt3QT88p9-14vzmvPM0Oa41Pu_qG5OjieGy8zJ3H6aQ_HEVj39j3W9b-czckaU3-XG-A1IPo/download

Authorization: Ejr2YotnFZFEjr1zCsicMWpAAotnFZFEjr1zCsic

X-Consumer-ID: TEST_CONSUMER_ID

X-Consumer-Custom-ID: TEST_CUSTOM_CONSUMER_ID

Host: localhost:8080

Example Curl Request

$ curl 'https://localhost:8080/consignments/5555/documents/AWzuzHXANd9erOsPSt3QT88p9-14vzmvPM0Oa41Pu_qG5OjieGy8zJ3H6aQ_HEVj39j3W9b-czckaU3-XG-A1IPo/download' -i -X GET \

-H 'Authorization: Ejr2YotnFZFEjr1zCsicMWpAAotnFZFEjr1zCsic' \

-H 'X-Consumer-ID: TEST_CONSUMER_ID' \

-H 'X-Consumer-Custom-ID: TEST_CUSTOM_CONSUMER_ID'

Headers

Header	Purpose	Values	Required?
Authorization	Provide bearer token	Bearer "{token}"	Y

Parameters

Parameter	Purpose	Values	Required?
id	Identifier for a consignment or cross-dock shipment	URL-encoded string, 1 to 12 characters	Y
documentId	Identifier for the document	String	Y

Response

Format	Data Type
application/octet-stream	pdf

All information contained herein is business confidential and proprietary and may not be reproduced in any form without advanced

written consent of an authorized officer of the copyright holder.

EULA - End User License Agreement